home *** CD-ROM | disk | FTP | other *** search
/ Atari Mega Archive 2 / Atari Mega Archive CD - Volume 2.iso / minix / up1510b.tgz / up1510b / doc / stevie.doc < prev    next >
Text File  |  1990-07-19  |  29KB  |  1,057 lines
  1.  
  2.  
  3.  
  4.                       STEVIE - An Aspiring VI Clone
  5.  
  6.                           User Reference - 3.44
  7.  
  8.                                Tony Andrews
  9.  
  10.  
  11.  
  12.        1.  _✓O_✓v_✓e_✓r_✓v_✓i_✓e_✓w
  13.  
  14.        STEVIE is an editor designed to mimic the interface  of  the
  15.        UNIX  editor  'vi'.  The name (ST Editor for VI Enthusiasts)
  16.        comes from the fact that the editor was  first  written  for
  17.        the  Atari  ST. The current version has been ported to UNIX,
  18.        Minix, MS-DOS, and OS/2, but I've left the name  intact  for
  19.        now.
  20.  
  21.        This program is the result of many late  nights  of  hacking
  22.        over  the  last year or so. The first version was written by
  23.        Tim Thompson and posted to USENET. From  there,  I  reworked
  24.        the  data structures completely, added LOTS of features, and
  25.        generally improved the overall performance in the process.
  26.  
  27.        I've labelled STEVIE an 'aspiring' vi clone as a warning  to
  28.        those  who  may expect too much. On the whole, the editor is
  29.        pretty complete. Almost all of the visual mode commands  are
  30.        supported.  I've tried very hard to capture the 'feel' of vi
  31.        by getting  the  little  things  right.  Making  lines  wrap
  32.        correctly,  supporting  true operators, and even getting the
  33.        cursor to land on the right place for tabs are  all  a  real
  34.        pain, but really help make the editor 'feel' right.
  35.  
  36.        STEVIE may be freely distributed.  The  source  isn't  copy-
  37.        righted  or  restricted  in any way. If you pass the program
  38.        along, please include all the documentation and, if  practi-
  39.        cal, the source as well. I'm not fanatical about this, but I
  40.        tried to make STEVIE fairly portable and that doesn't do any
  41.        good if the source isn't available.
  42.  
  43.        The remainder of this document describes  the  operation  of
  44.        the  editor.   This  is  intended  as  a reference for users
  45.        already familiar with the real vi editor.
  46.  
  47.  
  48.        2.  _✓S_✓t_✓a_✓r_✓t_✓i_✓n_✓g__✓t_✓h_✓e__✓E_✓d_✓i_✓t_✓o_✓r
  49.  
  50.        The following command line forms are supported:
  51.  
  52.        stevie [file ...]   Edit the specified file(s)
  53.  
  54.        stevie -t tag       Start at the location of the given tag
  55.  
  56.        stevie + file       Edit file starting at end
  57.  
  58.  
  59.  
  60.  
  61.  
  62.                                   - 1 -
  63.  
  64.  
  65.  
  66.  
  67.  
  68.  
  69.  
  70.        STEVIE                                        User Reference
  71.  
  72.  
  73.  
  74.        stevie +n file      Edit file starting a line number 'n'
  75.  
  76.        stevie +/pat file   Edit file starting at pattern 'pat'
  77.  
  78.        If multiple files are given on the command line  (using  the
  79.        first  form),  the  ":n" command goes to the next file, ":N"
  80.        goes backward in the list, and ":rew" can be used to  rewind
  81.        back to the start of the file list.
  82.  
  83.  
  84.        3.  _✓S_✓e_✓t__✓C_✓o_✓m_✓m_✓a_✓n_✓d__✓O_✓p_✓t_✓i_✓o_✓n_✓s
  85.  
  86.        The ":set" command works as usual to  set  parameters.  Each
  87.        parameter  has  a  long  and  an abbreviated name, either of
  88.        which may be used. Boolean parameters are set as in:
  89.  
  90.             set showmatch
  91.  
  92.        or cleared by:
  93.  
  94.             set noshowmatch
  95.  
  96.        Numeric parameters are set as in:
  97.  
  98.             set scroll=5
  99.  
  100.        Several parameters may be set with a single command:
  101.  
  102.             set novb sm report=1
  103.  
  104.        To see the status of all parameters use ":set  all".  Typing
  105.        ":set"  with  no  arguments  will show only those parameters
  106.        that have been changed.   The  supported  parameters,  their
  107.        names,  abbreviations,  defaults, and descriptions are shown
  108.        below:
  109.  
  110.  
  111.  
  112.  
  113.  
  114.  
  115.  
  116.  
  117.  
  118.  
  119.  
  120.  
  121.  
  122.  
  123.  
  124.  
  125.  
  126.  
  127.  
  128.                                   - 2 -
  129.  
  130.  
  131.  
  132.  
  133.  
  134.  
  135.  
  136.        STEVIE                                        User Reference
  137.  
  138.  
  139.  
  140.        autoindent  Short: ai, Default: noai, Type: Boolean
  141.                    When in insert mode, start new lines at the same
  142.                    column  as  the  prior  line. Unlike vi, you can
  143.                    backspace over the indentation.
  144.  
  145.        backup      Short: bk, Default: nobk, Type: Boolean
  146.                    Leave a backup on file writes.
  147.  
  148.        errorbells  Short: eb, Default: noeb, Type: Boolean
  149.                    Ring bell when error messages are shown.
  150.  
  151.        ignorecase  Short: ic, Default: noic, Type: Boolean
  152.                    Ignore case in string searches.
  153.  
  154.        lines       Short: lines, Default: lines=25, Type: Numeric
  155.                    Number of physical  lines  on  the  screen.  The
  156.                    default  value  actually  depends  on  the  host
  157.                    machine, but is generally 25.
  158.  
  159.        list        Short: list, Default: nolist, Type: Boolean
  160.                    Show tabs and newlines graphically.
  161.  
  162.        number      Short: nu, Default: nonu, Type: Boolean
  163.                    Display lines on  the  screen  with  their  line
  164.                    numbers.
  165.  
  166.        report      Short: report, Default: report=5, Type: Numeric
  167.                    Minimum number of lines to report operations on.
  168.  
  169.        return      Short: cr, Default: cr, Type: Boolean
  170.                    End lines with cr-lf when writing files.
  171.  
  172.        scroll      Short: scroll, Default: scroll=12, Type: Numeric
  173.                    Number of lines to scroll for ^D & ^U.
  174.  
  175.        showmatch   Short: sm, Default: nosm, Type: Boolean
  176.                    When a ), }, or ] is typed, show the matching (,
  177.                    {,  or [ if it's on the current screen by moving
  178.                    the cursor there briefly.
  179.  
  180.        showmode    Short: mo, Default: nomo, Type: Boolean
  181.                    Show on status line when in insert mode.
  182.  
  183.        tabstop     Short: ts, Default: ts=8, Type: Numeric
  184.                    Number of spaces in a tab.
  185.  
  186.        wrapscan    Short: ws, Default: ws, Type: Boolean
  187.                    String searches wrap  around  the  ends  of  the
  188.                    file.
  189.  
  190.  
  191.  
  192.  
  193.  
  194.                                   - 3 -
  195.  
  196.  
  197.  
  198.  
  199.  
  200.  
  201.  
  202.        STEVIE                                        User Reference
  203.  
  204.  
  205.  
  206.        vbell       Short: vb, Default: vb, Type: Boolean
  207.                    Use a visual bell, if possible. (novb for  audi-
  208.                    ble bell)
  209.  
  210.        The EXINIT environment variable can be used  to  modify  the
  211.        default values on startup as in:
  212.  
  213.             setenv EXINIT="set sm ts=4"
  214.  
  215.        The 'backup' parameter, if set, causes the editor to  retain
  216.        a  backup of any files that are written. During file writes,
  217.        a backup is always kept for safety until the write  is  com-
  218.        pleted.  At  that  point,  the 'backup' parameter determines
  219.        whether the backup file is deleted.
  220.  
  221.        In environments (e.g. OS/2 or TOS) where lines are  normally
  222.        terminated  by CR-LF, the 'return' parameter allows files to
  223.        be written with only a LF terminator (if  the  parameter  is
  224.        cleared).  This parameter is ignored on UNIX systems.
  225.  
  226.        The 'lines' parameter tells the editor how many lines  there
  227.        are  on  the  screen.  This is useful on systems like the ST
  228.        (or OS/2 machines with an EGA adapter) where various  screen
  229.        resolutions  may  be  used.  By using the 'lines' parameter,
  230.        different screen sizes can be easily handled.
  231.  
  232.  
  233.        4.  _✓C_✓o_✓l_✓o_✓n__✓C_✓o_✓m_✓m_✓a_✓n_✓d_✓s
  234.  
  235.        Several of the normal 'vi' colon commands are  supported  by
  236.        STEVIE.   Some  commands  may  be  preceded  by a line range
  237.        specification.  For commands that accept a range  of  lines,
  238.        the following address forms are supported:
  239.  
  240.             addr
  241.             addr + number
  242.             addr - number
  243.  
  244.        where 'addr' may be one of the following:
  245.  
  246.             a line number
  247.             a mark (as in 'a or 'b)
  248.             '.' (the current line)
  249.             '$' (the last line)
  250.  
  251.        An address range of "%" is accepted as  an  abbreviation  of
  252.        "1,$".
  253.  
  254.  
  255.  
  256.  
  257.  
  258.  
  259.  
  260.                                   - 4 -
  261.  
  262.  
  263.  
  264.  
  265.  
  266.  
  267.  
  268.        STEVIE                                        User Reference
  269.  
  270.  
  271.  
  272.        4.1  _✓T_✓h_✓e__✓G_✓l_✓o_✓b_✓a_✓l__✓C_✓o_✓m_✓m_✓a_✓n_✓d
  273.  
  274.        A limited form of the global command is supported, accepting
  275.        the following command form:
  276.  
  277.             g/pattern/X
  278.  
  279.        where X may be either 'd' or 'p' to delete  or  print  lines
  280.